#インターフェイス: プラグイン<TType, O>
#型パラメータ
| 名前 | タイプ |
|---|---|
TType | 伸びるChartType=ChartType |
O | AnyObject |
#階層
ExtendedPlugin<TType、O>↳
Plugin↳↳
Tooltip
#プロパティ
#デフォルト
•Optional デフォルト:Partial<O>
プラグインで使用されるデフォルトのオプション
#で定義
タイプ/index.d.ts:1116 (新しいウィンドウが開きます)
#ID
•ID:string
#で定義
タイプ/index.d.ts:817 (新しいウィンドウが開きます)
#メソッド
#afterBuildTicks
▸Optional afterBuildTicks(chart、args、options):void
Desc
スケールがティックを構築した後に呼び出されます。このフックは、チャート内のスケールごとに個別に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:976 (新しいウィンドウが開きます)
#データ制限後
▸Optional データ制限後(chart、args、options):void
Desc
スケール データ制限が計算された後に呼び出されます。このフックは、チャート内のスケールごとに個別に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:960 (新しいウィンドウが開きます)
#データセット描画後
▸Optional データセット描画後(chart、args、options):void
Desc
の後に呼び出されましたchart指定されたデータセットargs.index描かれています
(データセットは逆の順序で描画されます)。このフックは呼び出されないことに注意してください
データセットの描画が以前にキャンセルされている場合。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<キーオフChartTypeRegistry、default<AnyObject、AnyObject>、default<AnyObject、AnyObject>> | データセットのメタデータ。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1058 (新しいウィンドウが開きます)
#データセット更新後
▸Optional データセット更新後(chart、args、options):void
Desc
の後に呼び出されましたchart指定されたデータセットargs.indexが更新されました。ノート
データセットの更新が以前にキャンセルされている場合、このフックは呼び出されないこと。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | false | - |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<キーオフChartTypeRegistry、default<AnyObject、AnyObject>、default<AnyObject、AnyObject>> | データセットのメタデータ。 |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | 更新モード。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:935 (新しいウィンドウが開きます)
#データセット描画後
▸Optional データセット描画後(chart、args、options、cancelable):void
Desc
の後に呼び出されましたchartデータセットが描画されました。このフックに注意してください
データセットの描画が以前にキャンセルされている場合は呼び出されません。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | c6096f20-427f-4eef-8814-fffcce5fa208a | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
cancelable | false | - |
#戻り値
void
#で定義
タイプ/index.d.ts:1035 (新しいウィンドウが開きます)
#データセット更新後
▸Optional データセット更新後(chart、args、options):void
Desc
の後に呼び出されましたchartデータセットが更新されました。このフックに注意してください
データセットの更新が以前にキャンセルされている場合は呼び出されません。
Since
バージョン2.1.5
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | 更新モード。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:912 (新しいウィンドウが開きます)
#破壊後
▸Optional 破壊後(chart、args、options):void
チャートが破棄された後に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1103 (新しいウィンドウが開きます)
#afterDraw
▸Optional afterDraw(chart、args、options):void
Desc
の後に呼び出されましたchart描かれています。このフックは呼び出されないことに注意してください
抽選が以前にキャンセルされた場合。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1018 (新しいウィンドウが開きます)
#イベント後
▸1e1dddf7-da92-4100-bdc7-15d15f3b5cc6 イベント後(chart、args、options):void
Desc
の後に呼び出されましたevent消費されてしまった。このフックに注意してください
の場合は呼び出されませんevent以前に破棄されました。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | false | - |
args.changed? | boolean | プラグインがレンダリングを必要とする場合は true に設定します。この args オブジェクトはすべてのプラグインを介して渡されるため、true にのみ変更する必要があります。 |
args.event | ChartEvent | イベントオブジェクト。 |
args.inChartArea | boolean | イベントの位置は chartArea 内です |
args.replay | boolean | このイベントが次から再生される場合は TrueChart.update |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1081 (新しいウィンドウが開きます)
#初期化後
▸Optional 初期化後(chart、args、options):void
Desc
後に呼び出されましたchart初期化されており、最初のアップデート前です。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:856 (新しいウィンドウが開きます)
#後レイアウト
▸Optional 後レイアウト(chart、args、options):void
Desc
の後に呼び出されましたchartレイアウトされています。このフックは機能しないことに注意してください。
レイアウトの更新が以前にキャンセルされた場合に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:984 (新しいウィンドウが開きます)
#レンダリング後
▸Optional レンダリング後(chart、22ベッド530-4d52-4099-9083-66a04643fa5d、options):void
Desc
の後に呼び出されましたchart完全にレンダリングされました (アニメーションも完了しました)。ノート
レンダリングが以前にキャンセルされている場合、このフックは呼び出されないことを示します。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1001 (新しいウィンドウが開きます)
#ツールチップ描画後
▸Optional ツールチップ描画後(chart、args、options):void
Desc
を描画した後に呼び出されますtooltip。このフックは機能しないことに注意してください。
ツールチップの描画が以前にキャンセルされている場合に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.tooltip | TooltipModel<TType> | ツールチップ。 |
options | O | プラグインのオプション。 |
#戻り値
void
#継承元
#で定義
タイプ/index.d.ts:2670 (新しいウィンドウが開きます)
#更新後
▸Optional 更新後(chart、args、options):void
Desc
後に呼び出されましたchart更新されており、レンダリング前です。これに注意してください
チャートの更新が以前にキャンセルされている場合、フックは呼び出されません。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | アップデートモード |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:875 (新しいウィンドウが開きます)
#beforeBuildTicks
▸Optional beforeBuildTicks(chart、args、options):void
Desc
スケールがティックを構築する前に呼び出されます。このフックは、チャート内のスケールごとに個別に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:968 (新しいウィンドウが開きます)
#データ制限前
▸Optional データ制限前(chart、args、options):void
Desc
スケール データ制限が計算される前に呼び出されます。このフックは、チャート内のスケールごとに個別に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.scale | Scale<CoreScaleOptions> | スケール。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:952 (新しいウィンドウが開きます)
#データセット描画前
▸Optional データセット描画前(chart、args、options):boolean|void
Desc
を描画する前に呼び出されますchart指定されたデータセットargs.index(データセット
逆の順序で描画されます）。プラグインが返された場合false、データセットの描画
次の時間までキャンセルされますrenderがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<キーオフChartTypeRegistry、default<AnyObject、AnyObject>、default<AnyObject、AnyObject>> | データセットのメタデータ。 |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャート データセットの描画をキャンセルします。
#で定義
タイプ/index.d.ts:1047 (新しいウィンドウが開きます)
#データセット更新前
▸Optional データセット更新前(chart、args、options):boolean|void
Desc
を更新する前に呼び出されるchart指定されたデータセットargs.index。プラグインがあれば
戻り値false、データセットの更新は別の更新が行われるまでキャンセルされます。updateがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
args.index | number | データセットのインデックス。 |
args.meta | ChartMeta<キーオフChartTypeRegistry、default<AnyObject、AnyObject>、default<AnyObject、AnyObject>> | データセットのメタデータ。 |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | 更新モード。 |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャート データセットの描画をキャンセルします。
#で定義
タイプ/index.d.ts:924 (新しいウィンドウが開きます)
#データセット描画前
▸Optional データセット描画前(chart、args、options):boolean|void
Desc
を描画する前に呼び出されますchartデータセット。プラグインが返された場合false、
データセットの描画は別の操作が行われるまでキャンセルされます。renderがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャート データセットの描画をキャンセルします。
#で定義
タイプ/index.d.ts:1027 (新しいウィンドウが開きます)
#データセット更新前
▸Optional データセット更新前(chart、args、options):boolean|void
Desc
を更新する前に呼び出されるchartデータセット。プラグインが返された場合false、
データセットの更新は別の更新が行われるまでキャンセルされます。updateがトリガーされます。
Since
バージョン2.1.5
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | 更新モード。 |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
データセットの更新をキャンセルする場合は false。
#で定義
タイプ/index.d.ts:902 (新しいウィンドウが開きます)
#前に破壊する
▸Optional 前に破壊する(chart、args、options):void
チャートが破棄される前に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1096 (新しいウィンドウが開きます)
#描画前
▸Optional 描画前(chart、args、options):boolean|void
Desc
描画前に呼び出されるchartアニメーションフレームごとに。プラグインが返された場合false、
フレーム描画は次の操作が行われるまでキャンセルされますrenderがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャートの描画をキャンセルします。
#で定義
タイプ/index.d.ts:1010 (新しいウィンドウが開きます)
#beforeElementsUpdate
▸Optional beforeElementsUpdate(chart、args、options):void
Desc
更新プロセス中に、チャート要素が作成される前に呼び出されます。 これは、データセット内のデータ配列を変更することによるデータ間引きに使用できます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:883 (新しいウィンドウが開きます)
#イベント前
▸Optional イベント前(chart、args、options):boolean|void
Desc
指定されたものを処理する前に呼び出されますevent。プラグインが返された場合false、
イベントは破棄されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
args.event | ChartEvent | イベントオブジェクト。 |
args.inChartArea | boolean | イベントの位置は chartArea 内です |
args.replay | boolean | このイベントが次から再生される場合は TrueChart.update |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
#で定義
タイプ/index.d.ts:1069 (新しいウィンドウが開きます)
#初期化前
▸Optional 初期化前(chart、args、options):void
Desc
初期化前に呼び出されるchart。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:849 (新しいウィンドウが開きます)
#beforeレイアウト
▸Optional beforeレイアウト(chart、args、options):boolean|void
Desc
レイアウト前に呼び出されるchart。プラグインが返された場合false、
レイアウトの更新は次の操作が行われるまでキャンセルされます。updateがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseグラフのレイアウトをキャンセルします。
#で定義
タイプ/index.d.ts:944 (新しいウィンドウが開きます)
#レンダリング前
▸Optional レンダリング前(chart、args、options):boolean|void
Desc
レンダリング前に呼び出されるchart。プラグインが返された場合false、
レンダリングは次の操作が行われるまでキャンセルされます。renderがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
options | O | プラグインのオプション。 |
#戻り値
boolean|3753c7f9-04be-44c3-a878-e86a48a99悪い
falseチャートのレンダリングをキャンセルします。
#で定義
タイプ/index.d.ts:993 (新しいウィンドウが開きます)
#ツールチップ描画前
▸Optional ツールチップ描画前(chart、args、options):boolean|void
Desc
を描画する前に呼び出されますtooltip。プラグインが返された場合false、
ツールチップの描画は次の操作が行われるまでキャンセルされます。renderがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [51c0949b-3c26-4359-8f62-a3561ed6490b、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | 75b7ca7e-a057-4e2d-b1af-67da50556eba | - |
args.tooltip | TooltipModel<TType> | ツールチップ。 |
options | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャートのツールチップの描画をキャンセルします。
#継承元
#で定義
タイプ/index.d.ts:2661 (新しいウィンドウが開きます)
#更新前
▸Optional 更新前(9a955786-e47c-4c14-93d0-72140cb4640d、args、options):boolean|void
Desc
更新前に呼び出されるchart。プラグインが返された場合false、 更新
別の操作が行われるまでキャンセルされます (したがってその後のレンダリングもキャンセルされます)。updateがトリガーされます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.cancelable | true | - |
args.mode | "none"|"hide"|"show"|"default"|"active"|"resize"|"reset" | アップデートモード |
| dddd9a7-7493-4a97-8513-66ce7ea2120d | O | プラグインのオプション。 |
#戻り値
boolean|void
falseチャートの更新をキャンセルします。
#で定義
タイプ/index.d.ts:866 (新しいウィンドウが開きます)
#インストール
▸Optional インストール(chart、args、options):void
Desc
このチャート インスタンスにプラグインがインストールされるときに呼び出されます。このフックは、無効化されたプラグインに対しても呼び出されます (オプション === false)。
Since
3.0.0
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:826 (新しいウィンドウが開きます)
#リセット
▸Optional リセット(chart、args、options):void
Desc
チャートのリセット中に呼び出されます
Since
バージョン3.0.0
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:891 (新しいウィンドウが開きます)
#サイズ変更
▸Optional サイズ変更(chart、args、options):void
Desc
チャートのサイズが変更された後に呼び出されます。
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | Object | 呼び出しの引数。 |
args.size | Object | 新しいキャンバスの表示サイズ (canvas.style の幅と高さなど)。 |
args.size.height | number | - |
args.size.width | number | - |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1089 (新しいウィンドウが開きます)
#始める
▸Optional 始める(chart、args、options):void
Desc
プラグインの起動時に呼び出されます。これは、チャートが作成されている場合、またはプラグインが有効になっている場合に発生します。
Since
3.0.0
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:834 (新しいウィンドウが開きます)
#ストップ
▸Optional ストップ(chart、args、options):void
Desc
プラグインの停止時に呼び出されます。これは、チャートが破壊されているか、プラグインが無効になっている場合に発生します。
Since
3.0.0
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:842 (新しいウィンドウが開きます)
#アンインストール
▸Optional アンインストール(chart、args、options):void
そのチャートにインストールされているすべてのプラグインでチャートが破棄された後に呼び出されます。このフックは、無効化されたプラグインに対しても呼び出されます (オプション === false)。
Since
3.0.0
#パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
chart | Chart<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown> | チャートインスタンス。 |
args | EmptyObject | 呼び出しの引数。 |
options | O | プラグインのオプション。 |
#戻り値
void
#で定義
タイプ/index.d.ts:1111 (新しいウィンドウが開きます)